Skip to content

Add temporal-tool-registry module with AgenticSession support#2839

Open
lex00 wants to merge 5 commits intotemporalio:masterfrom
lex00:feat/tool-registry
Open

Add temporal-tool-registry module with AgenticSession support#2839
lex00 wants to merge 5 commits intotemporalio:masterfrom
lex00:feat/tool-registry

Conversation

@lex00
Copy link
Copy Markdown

@lex00 lex00 commented Apr 13, 2026

What was changed

New temporal-tool-registry module for running LLM tool-calling loops inside Temporal activities.

  • ToolRegistry — maps tool names to JSON Schema definitions and handler functions
  • RunToolLoop — standalone tool loop, no Temporal worker required
  • AgenticSession — crash-safe wrapper that checkpoints conversation history via Activity.getExecutionContext().heartbeat() on each turn and restores on retry; session survives both activity crashes and provider-side session expiry since state is stored locally
  • Built-in AnthropicProvider and OpenAIProvider
  • MockProvider and MockResponse for unit testing without a live API key
  • ToolRegistry.fromMcpTools — converts a list of MCP tool descriptors into a populated registry

Bug fix included

The Anthropic provider now sets is_error: true on tool result maps when a handler throws, matching the Anthropic API spec. A new test (testAnthropicProvider_HandlerError_SetsIsError) verifies this using an in-process HTTP server. OpenAI has no equivalent field.

Why?

Temporal activities are a natural fit for LLM tool-calling loops, but every team reimplements the same boilerplate. This module standardizes the pattern across all six Temporal SDKs. Java has no framework-level LLM integration (Python's openai_agents/google_adk_agents and TypeScript's @temporalio/ai-sdk are Python/TypeScript only), so this is the recommended path for direct Anthropic/OpenAI calls in Java.

Proposal: temporalio/proposals#107

Checklist

  1. Related to: Add ToolRegistry + AgenticSession proposal proposals#107
  2. How was this tested: unit tests with MockProvider (no API key required); integration tests against live Anthropic and OpenAI APIs gated on RUN_INTEGRATION_TESTS=1 (skipped by default)
  3. Any docs updates needed? Yes — docs.temporal.io update to follow after merge

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@lex00 lex00 requested a review from a team as a code owner April 13, 2026 03:53
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Apr 13, 2026

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

lex00 and others added 4 commits April 12, 2026 22:41
Adds McpTool POJO and ToolRegistry.fromMcpTools static method that converts a
list of MCP tool descriptors into a populated ToolRegistry. Handlers default to
no-ops; callers override with register after construction. Null inputSchema is
normalized to an empty object schema.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Set is_error=Boolean.TRUE on Anthropic tool result maps when a handler
  throws, matching the Anthropic API spec; OpenAI has no equivalent field
- Add testAnthropicProvider_HandlerError_SetsIsError using an in-process
  HTTP server to verify is_error propagation without a real API key
- Update README to clarify positioning vs Python/TypeScript framework plugins

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…out docs

- Rename AgenticSession.issues → results, getIssues() → getResults(),
  addIssue() → addResult(); rename SessionCheckpoint JSON key 'issues' → 'results'
- Remove unused system parameter from AgenticSession.runToolLoop and
  ToolRegistry.runToolLoop
- Add ScheduleToCloseTimeout guidance to README
- Update all test call sites

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The quickstart example used `issues` as the local collector variable, left
over from before the AgenticSession field was renamed to `getResults()` in round 2.
Rename to `results` so the example is consistent with the other SDK READMEs.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants